<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Kyoto Cabinet: kyotocabinet::DB::Visitor Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />



</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Kyoto Cabinet
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a>      </li>
      <li class="navelem"><a class="el" href="classkyotocabinet_1_1DB.html">DB</a>      </li>
      <li class="navelem"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html">Visitor</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a>  </div>
  <div class="headertitle">
<div class="title">kyotocabinet::DB::Visitor Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="kyotocabinet::DB::Visitor" -->
<p>Interface to access a record.  
 <a href="classkyotocabinet_1_1DB_1_1Visitor.html#details">More...</a></p>

<p><code>#include &lt;kcdb.h&gt;</code></p>

<p><a href="classkyotocabinet_1_1DB_1_1Visitor-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#afcb5b4a4c0935a9818e88fe5d6d56b21">~Visitor</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#afcb5b4a4c0935a9818e88fe5d6d56b21"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a5aea6d12932bbfabdf563fd07bdc2ebb">visit_full</a> (const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz, size_t *sp)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Visit a record.  <a href="#a5aea6d12932bbfabdf563fd07bdc2ebb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a09a935a06d2298f8c9165b825425287a">visit_empty</a> (const char *kbuf, size_t ksiz, size_t *sp)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Visit a empty record space.  <a href="#a09a935a06d2298f8c9165b825425287a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a7874d9471bb22216da910c7d1df9866d">visit_before</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Preprocess the main operations.  <a href="#a7874d9471bb22216da910c7d1df9866d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a4085ee3747c93f45b39f68cf6c474afc">visit_after</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Postprocess the main operations.  <a href="#a4085ee3747c93f45b39f68cf6c474afc"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#aaf5bcec941a585d3b619151263906b95">NOP</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Special pointer for no operation.  <a href="#aaf5bcec941a585d3b619151263906b95"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a867859f14e90d49802c79e178e68c5c4">REMOVE</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Special pointer to remove the record.  <a href="#a867859f14e90d49802c79e178e68c5c4"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Interface to access a record. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="afcb5b4a4c0935a9818e88fe5d6d56b21"></a><!-- doxytag: member="kyotocabinet::DB::Visitor::~Visitor" ref="afcb5b4a4c0935a9818e88fe5d6d56b21" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#afcb5b4a4c0935a9818e88fe5d6d56b21">kyotocabinet::DB::Visitor::~Visitor</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Destructor. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5aea6d12932bbfabdf563fd07bdc2ebb"></a><!-- doxytag: member="kyotocabinet::DB::Visitor::visit_full" ref="a5aea6d12932bbfabdf563fd07bdc2ebb" args="(const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz, size_t *sp)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a5aea6d12932bbfabdf563fd07bdc2ebb">kyotocabinet::DB::Visitor::visit_full</a> </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>kbuf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>ksiz</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>vbuf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>vsiz</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *&#160;</td>
          <td class="paramname"><em>sp</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Visit a record. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">kbuf</td><td>the pointer to the key region. </td></tr>
    <tr><td class="paramname">ksiz</td><td>the size of the key region. </td></tr>
    <tr><td class="paramname">vbuf</td><td>the pointer to the value region. </td></tr>
    <tr><td class="paramname">vsiz</td><td>the size of the value region. </td></tr>
    <tr><td class="paramname">sp</td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>If it is the pointer to a region, the value is replaced by the content. If it is <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#aaf5bcec941a585d3b619151263906b95" title="Special pointer for no operation.">Visitor::NOP</a>, nothing is modified. If it is <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a867859f14e90d49802c79e178e68c5c4" title="Special pointer to remove the record.">Visitor::REMOVE</a>, the record is removed. </dd></dl>

</div>
</div>
<a class="anchor" id="a09a935a06d2298f8c9165b825425287a"></a><!-- doxytag: member="kyotocabinet::DB::Visitor::visit_empty" ref="a09a935a06d2298f8c9165b825425287a" args="(const char *kbuf, size_t ksiz, size_t *sp)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a09a935a06d2298f8c9165b825425287a">kyotocabinet::DB::Visitor::visit_empty</a> </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>kbuf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>ksiz</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *&#160;</td>
          <td class="paramname"><em>sp</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Visit a empty record space. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">kbuf</td><td>the pointer to the key region. </td></tr>
    <tr><td class="paramname">ksiz</td><td>the size of the key region. </td></tr>
    <tr><td class="paramname">sp</td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>If it is the pointer to a region, the value is replaced by the content. If it is <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#aaf5bcec941a585d3b619151263906b95" title="Special pointer for no operation.">Visitor::NOP</a> or <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a867859f14e90d49802c79e178e68c5c4" title="Special pointer to remove the record.">Visitor::REMOVE</a>, nothing is modified. </dd></dl>

</div>
</div>
<a class="anchor" id="a7874d9471bb22216da910c7d1df9866d"></a><!-- doxytag: member="kyotocabinet::DB::Visitor::visit_before" ref="a7874d9471bb22216da910c7d1df9866d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a7874d9471bb22216da910c7d1df9866d">kyotocabinet::DB::Visitor::visit_before</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Preprocess the main operations. </p>

</div>
</div>
<a class="anchor" id="a4085ee3747c93f45b39f68cf6c474afc"></a><!-- doxytag: member="kyotocabinet::DB::Visitor::visit_after" ref="a4085ee3747c93f45b39f68cf6c474afc" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a4085ee3747c93f45b39f68cf6c474afc">kyotocabinet::DB::Visitor::visit_after</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Postprocess the main operations. </p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aaf5bcec941a585d3b619151263906b95"></a><!-- doxytag: member="kyotocabinet::DB::Visitor::NOP" ref="aaf5bcec941a585d3b619151263906b95" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* const <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#aaf5bcec941a585d3b619151263906b95">kyotocabinet::DB::Visitor::NOP</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Special pointer for no operation. </p>

</div>
</div>
<a class="anchor" id="a867859f14e90d49802c79e178e68c5c4"></a><!-- doxytag: member="kyotocabinet::DB::Visitor::REMOVE" ref="a867859f14e90d49802c79e178e68c5c4" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* const <a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html#a867859f14e90d49802c79e178e68c5c4">kyotocabinet::DB::Visitor::REMOVE</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Special pointer to remove the record. </p>

</div>
</div>
</div><!-- contents -->


<hr class="footer"/><address class="footer"><small>
Generated on Fri May 25 2012 01:21:36 for Kyoto Cabinet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
